HTTPPollDefs


Schema to define HTTP polls for a device

root oneOf PollsArray
Type: array
No Additional Items

Each item of this array must be:

root oneOf item 0 PollsEntry
Type: object
No Additional Properties

root oneOf item 0 item 0 items pollRate

Duration

Type: object

Schema to define a finite duration

 No Additional Properties

root oneOf item 0 item 0 items pollRate unit
Type: enum (of string)

Must be one of:

  • "microsecond"
  • "microseconds"
  • "micro"
  • "micros"
  • "µs"
  • "millisecond"
  • "milliseconds"
  • "milli"
  • "millis"
  • "ms"
  • "second"
  • "seconds"
  • "s"
  • "minute"
  • "minutes"
  • "m"
  • "hour"
  • "hours"
  • "h"
  • "day"
  • "days"
  • "d"

root oneOf item 0 item 0 items polls
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls HttpPoll
Type: object

root oneOf item 0 item 0 items polls polls items oneOf PlainHttpPoll
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 name
Type: string

Must be at least 1 characters long

root oneOf item 0 item 0 items polls polls items oneOf item 0 request
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request protocol
Type: enum (of string)

Must be one of:

  • "http"
  • "https"

root oneOf item 0 item 0 items polls polls items oneOf item 0 request port
Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers
Type: object

Basically the same structure for headers / query params / form data

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .*

root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 0
Type: string
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 1
Type: array of string
No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 1 item 1 items
Type: string
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 2
Type: number
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 3
Type: array of number
No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 3 item 3 items
Type: number
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 4
Type: boolean
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 5
Type: array of boolean
No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf item 5 item 5 items
Type: boolean
root oneOf item 0 item 0 items polls polls items oneOf item 0 request headers .* oneOf FileUploadObject
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request path
Type: string
Must match regular expression: ^[/].*$

root oneOf item 0 item 0 items polls polls items oneOf item 0 request queryParameters
Type: object

Basically the same structure for headers / query params / form data

Same definition as headers

root oneOf item 0 item 0 items polls polls items oneOf item 0 request method
Type: enum (of string)

Must be one of:

  • "GET"
  • "PATCH"
  • "POST"
  • "PUT"
  • "DELETE"
  • "HEAD"
  • "OPTIONS"

root oneOf item 0 item 0 items polls polls items oneOf item 0 request timeout

Duration

Type: object

Schema to define a finite duration

Same definition as pollRate

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body text
Type: string

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body json
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf XmlStringBody
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf item 0 xmlString
Type: string
root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf XmlJsonBody
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf item 1 xmlJson
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf item 1 options
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf item 1 options removeHeader
Type: boolean

Don't include the <?xml ... ?> header

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body xml oneOf item 1 options prettyPrint
Type: boolean

root oneOf item 0 item 0 items polls polls items oneOf item 0 request body form
Type: object

Basically the same structure for headers / query params / form data

Same definition as headers
root oneOf item 0 item 0 items polls polls items oneOf TwoStageHttpPoll
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial
Type: object

Transform the response, ensure the transformed output matches the schema, then transform the result again to get the poll state for followup

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf BaseStage
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform

DataTransformation

Type: object

Configurations for transforming data coming from devices

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf DataTransformationOperation
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Array
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf BaseTransform
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 pathToArray
Type: string

Optional, JSONPath to array if not operating on it directly

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 0
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 1
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 2
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 3
Type: object

Sum the numeric values in an array

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 4
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 5
Type: object

Flatten an array of arrays

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 6
Type: object

Combine an array of objects into one object

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 6 overwriteValues
Type: boolean

Choose to overwrite values for duplicate keys or form a list of values
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 7

Filter an array

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 7 oneOf item 0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 7 oneOf item 0 allOf BaseFilterProperties
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 7 oneOf item 0 allOf item 1
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 7 oneOf item 1

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 8
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 9
Type: object

Reduce an array. The transform will be run on each item in the array, with the input to the transform being an object with fields acc and current. The acc field will be populated with the xform init parameter for the first element. If the output of the transform is an object with an acc field, that will be used as the newly-accumulated value, otherwise the whole output will be in the acc field on the next item.

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 10
Type: object

Convert an array of numbers to a string. Defaults to utf-8 encoding.

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 10 encoding

BinaryEncoding

Type: enum (of string)

Must be one of:

  • "base64"
  • "hex"
  • "utf8"
  • "utf16le"
  • "latin1"
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 0 allOf item 1 operation oneOf item 11
Type: object

Reverse an arrays items.

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Binary
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Checksum
Type: object

Generates checksum from input string and returns isValid boolean or checksum-inserted string

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 2 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 2 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 2 allOf item 1 algorithm
Type: enum (of string)

Name of the algorithm (i.e. miteq, twoCharSum, mclCRC16)

Must be one of:

  • "miteq"
  • "twoCharSum"
  • "mclCRC16"

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 2 allOf item 1 inputJsonPath
Type: string

Path to string property containing message to checksum

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf CombineOn
Type: object

Take an array of objects and a field to combine on, and output an array of objects with that field being unique among them, and other fields combined into arrays.
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Combinations
Type: object

Takes two arrays of objects and outputs one array with all the combinations of values of both. Transformation(s) can be provided to modify the output.

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 4 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 4 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf CopyField
Type: object

Make a copy of a field with a new name or multiple new names

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 5 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 5 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 5 allOf item 1 rootPathToCopy
Type: string

Copy a field from the root (ignoring operateOn) instead of using fieldName

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Extract
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf FieldFilter
Type: object

Keep or discard the given fields
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Insert
Type: object

Insert fields into an object, or values into an array

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 8 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 8 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Join
Type: object

Takes two arrays of objects, and outputs one array of combined objects, joined by a key field.

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 9 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 9 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 9 allOf item 1 keyArrayPath
Type: string

JSONPath to first array. The key field in this array should have unique values for each object.

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 9 allOf item 1 joinArrayPath
Type: string

JSONPath to second array. The non-key fields of objects in this array will be collected into arrays on the matching record from the first array.

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 9 allOf item 1 keepObjects
Type: boolean

Flag to keep the non key fields as objects. If not defined will turn non key fields into arrays. If using this flag and there are multiple values for a field based on the join, the last one will be chosen
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Keys
Type: object

Take an object and return an array where all the keys are extracted from the input object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Entries
Type: object

Take an object and return an array of arrays where the inner array is [key, value]
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf KeyValue
Type: object

Take an array of objects and build one object where keys and values are extracted from array rows (or the reverse)
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf MacAddress
Type: object

Should be passed a base64 string
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Math
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1 op

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1 op oneOf item 0
Type: enum (of string)

Must be one of:

  • "ctof"
  • "ftoc"
  • "round"
  • "floor"
  • "ceil"
  • "sqrt"
  • "~"
  • "NOT"
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1 op oneOf item 1
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1 op oneOf item 2
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 14 allOf item 1 op oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "**"
  • "pow"
  • "*"
  • "times"
  • "/"
  • "div"
  • "<<"
  • ">>"
  • ">>>"
  • "+"
  • "plus"
  • "add"
  • "-"
  • "minus"
  • "sub"
  • "subtract"
  • "&"
  • "AND"
  • "|"
  • "OR"
  • "^"
  • "XOR"
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Merge
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Move
Type: object

Move data

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf MoveToSubField
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf BaseMove
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf item 1 toSubField

The current data (from operateOn) is replaced within an object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf item 1 toSubField oneOf item 0
Type: string

--> {[toSubField]: currData}
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf item 1 toSubField oneOf item 1
Type: array of string

'toSubField': ['a', 'b'] --> {'a': {'b': oldData}}

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 0 allOf item 1 toSubField oneOf item 1 item 1 items
Type: string

Must be at least 1 characters long

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf MoveWithJSONPath
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 1 allOf BaseMove
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i16_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 1 allOf item 1
Type: object

Take a value and move it elsewhere. Tries to intelligently handle objects/arrays

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 1 allOf item 1 target
Type: string

JSONPath to where value will be placed, or root if unspecified

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 16 oneOf item 1 allOf item 1 targetField
Type: string

If target is an object and this is specified, add this field with the source value
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf MultipleDataSource
Type: object

Takes the array of packets from a multiple-datasource field and transforms it into an object with the given field names and their payloads, optionally transformed

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 17 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 17 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 17 allOf item 1 fields
Type: array of object
No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 17 allOf item 1 fields fields items
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 17 allOf item 1 fields fields items fieldName
Type: string

Name in the final object which will contain the payload for this DS

Must be at least 1 characters long

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf NumberBitManipulation
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "numberBitManipulation"

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf item 1 operation

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf item 1 operation oneOf item 0
Type: object

Convert a signed integer to an unsigned integer or vice versa

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 18 allOf item 1 operation oneOf item 1
Type: object

Convert a little endian integer to a bit endian integer or vice versa

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf NumberManipulation
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 0
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/parseInt

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 1
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/parseFloat

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 2
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 3
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 4
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 19 allOf item 1 operation oneOf item 5
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf ParseSnmpV2DateAndTime
Type: object

Parse a date time specification from an SNMP octet string value
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf RegexGroups
Type: object

Takes a regex with named groups and outputs the match(es) as object(s)
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf ReplaceValue
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 replacements

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 replacements oneOf item 0
Type: object

Lookup table, incoming values will be replaced with their matching entry. If regex flag is true, keys should be valid regex patterns
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 replacements oneOf item 1
Type: string

JSONPath expression that resolves to an object to which the same rules apply. This expression is applied to the original value (before operateOn is taken into account).

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 regex
Type: boolean

If true, replacement keys must be valid regexes, and replacement values can be strings with $1 - $99 placeholders for match groups

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 regexFlags

RegexFlags

Type: array of enum (of string)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp

All items must be unique

No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 22 allOf item 1 regexFlags regexFlags items
Type: enum (of string)

Must be one of:

  • "g"
  • "i"
  • "m"
  • "s"
  • "u"
  • "y"
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Rule
Type: object

Runs a rule with json-rules-engine and outputs based on whether the rule evaluates to true or false

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule

RuleXformRule

Type: object

A subset of json-rules-engine rules to be used in xforms

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf NormalRule
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf ConditionProperties
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 0 oneOf NormalCondition
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 0 oneOf item 0 allOf BaseConditionProperties
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 0 oneOf item 0 allOf item 1
Type: object

Must provide one of value or valuePath

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 0 oneOf item 0 allOf item 1 operator

NormalRuleOperator

Type: enum (of string)

Must be one of:

  • "equal"
  • "notEqual"
  • "lessThan"
  • "lessThanInclusive"
  • "greaterThan"
  • "greaterThanInclusive"
  • "in"
  • "notIn"
  • "contains"
  • "doesNotContain"
  • "countEqual"
  • "countGreaterThan"
  • "countLessThan"
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 0 oneOf IsDefinedCondition
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf TopLevelCondition
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 1 oneOf AllConditions
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf item 0 conditions oneOf item 1 oneOf AnyConditions
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 23 allOf item 1 rule oneOf SwitchRule
Type: object
No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Sets
Type: object

Treat two arrays as sets and perform set operations on them.
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf SharedReference
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 25 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 25 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 25 allOf item 1 name
Type: string

Name of the shared xforms file containing the transform

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 25 allOf item 1 variables
Type: object

A shared xform may define variables it can take in, if it does then values need to be provided to replace them with

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .+
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 25 allOf item 1 variables .+
Type: string
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf SnmpGet
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 26 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 26 allOf item 1
Type: object

Apply transform(s) to an snmpGet payload, looked up by OID

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 26 allOf item 1 oids
Type: object

OID keys

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 26 allOf item 1 oids ^(\d+[.])*\d+$
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf SnmpGetTable
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 27 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 27 allOf item 1
Type: object

Apply transform(s) to columns in each row of an snmpGetTable payload

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 27 allOf item 1 columnOids
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 27 allOf item 1 columnOids ^(\d+[.])*\d+$
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 27 allOf item 1 keyedByIndex
Type: boolean

Set to true to output an array of objects keyed by index
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf ST
Type: object
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf StringManipulation
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 0
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 1
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 2
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 3
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 4
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimEnd

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 5
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimStart

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 6
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 7
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 8
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 9
Type: object

Convert string to array of code points

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 29 allOf item 1 operation oneOf item 10
Type: object

Join different strings together

 No Additional Properties
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf TextParse
Type: object

Create an object based on regex searches through text

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 30 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 30 allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 30 allOf item 1 searches
Type: object

Keys are regexes to search for

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 30 allOf item 1 searches .*
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf Script
Type: object

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 31 allOf BaseTransform
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0_oneOf_i0_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 31 allOf item 1
Type: object

Transform with a JS Script

 No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 0 oneOf item 31 allOf item 1 script
Type: string

Runs a basic JS Script and outputs the returned result. A const input holds the result of the previous transforms.

Must match regular expression: ^((?!(\b(eval|Function|import|export|function|fs|file|File|os|close|open|addEventListener|removeEventListener|console|location|write|body|localStorage|sessionStorage|document|window|alert))[; .({]).)*$
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf DataTransformationArray
Type: array
No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheckTransform oneOf item 1 DataTransformationOperation
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0_successCheckTransform_oneOf_i0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck

Core schema meta-schema

Type: object or boolean Default: true

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck multipleOf
Type: number

Value must be strictly greater than 0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck maxLength
Type: integer

Value must be greater or equal to 0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck required
Type: array of string Default: []

All items must be unique

No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck required required items
Type: string

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck definitions
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck definitions Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck properties
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck properties Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck patternProperties
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck patternProperties Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck enum
Type: array

Must contain a minimum of 1 items

All items must be unique

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck if

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck then

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck else

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck not

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck
root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 1 pollStateTransform

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform

root oneOf item 0 item 0 items polls polls items oneOf item 1 followup
Type: object

Run this request with the poll state from the initial stage until a success or failure result

root oneOf item 0 item 0 items polls polls items oneOf item 1 followup allOf BaseStage
Type: object
Same definition as oneOf_i0_items_polls_items_oneOf_i1_initial_allOf_i0
root oneOf item 0 item 0 items polls polls items oneOf item 1 followup allOf item 1
Type: object
No Additional Properties

root oneOf item 0 item 0 items polls polls items oneOf item 1 followup allOf item 1 failureCheckTransform

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform

root oneOf item 0 item 0 items polls polls items oneOf item 1 followup allOf item 1 failureCheck

Core schema meta-schema

Type: object or boolean Default: true

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck multipleOf
Type: number

Value must be strictly greater than 0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck maxLength
Type: integer

Value must be greater or equal to 0

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck required
Type: array of string Default: []

All items must be unique

No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck required required items
Type: string

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck definitions
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck definitions Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck properties
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck properties Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck patternProperties
Type: object Default: {}

Each additional property must conform to the following schema

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck patternProperties Core schema meta-schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck enum
Type: array

Must contain a minimum of 1 items

All items must be unique

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck if

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck then

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck else

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

root oneOf item 0 item 0 items polls polls items oneOf item 1 initial allOf item 0 successCheck not

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck
root oneOf HttpDevicePollsDefinition
Type: object
No Additional Properties

root oneOf item 1 transientToken
Type: object

root oneOf item 1 transientToken allOf TransientTokenHandling

TransientTokenHandling

Type: object

Describes how to configure devices that need to fetch an auth token

 No Additional Properties

root oneOf item 1 transientToken allOf TransientTokenHandling creation
Type: object

root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf CreationByPath
Type: object

root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 0 allOf BaseTokenCreation
Type: object

If username/password credentials are associated with this data collection, the given request object will have '${username}' and '${password}' replaced before sending.

 No Additional Properties
root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 0 allOf ExtractTokenByPath
Type: object

Simple json path to extract token from response

 No Additional Properties

root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 0 allOf item 1 tokenJsonPath
Type: string

Json Path to retrieve the token from the Rest response, which will be an HttpPayload
root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf CreationByTransform
Type: object

root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 1 allOf BaseTokenCreation
Type: object

If username/password credentials are associated with this data collection, the given request object will have '${username}' and '${password}' replaced before sending.

Same definition as oneOf_i1_transientToken_allOf_i0_creation_oneOf_i0_allOf_i0
root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 1 allOf ExtractTokenByTransform
Type: object

Run a transform on response to get token; transform result must be a string

 No Additional Properties

root oneOf item 1 transientToken allOf TransientTokenHandling creation oneOf item 1 allOf item 1 tokenTransform

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform
root oneOf item 1 transientToken allOf HttpPollTransientTokenHandlingExtraInfo
Type: object

Tell the system when a poll return signifies an auth failure, so the token should be refreshed. The received HttpPayload will be sent into the transform, and if the transformed output is equal to authFailedOutput then token refresh is required. Example: the status field of the payload could be extracted in xform and authFailedOutput be set to the value 403, if the server sends a forbidden response for an expired token.

 No Additional Properties

root oneOf item 1 transientToken allOf item 1 authFailedTransform

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform